Nova UI API

Embedding the Nova UI

Since Nova 2.14 it is possible to configure parts of the Nova UI using query string parameters, this is useful for embedding the Nova UI in iframes or other web applications, for example:

<iframe src="http://<ip>/#/dashboard?hideShell=true" width="100%" height="600px"></iframe>

Dashboard API

The base URL for the dashboard is:

http://<ip>/#/dashboard?hideShell=true

  • hideShell=true|false - Hides the application header and footer.

Viewer API

The base URL for the viewer is:

http://<ip>/#/viewer?hideShell=true

Supported query parameters:

  • hideShell=true|false - Hides the application header and footer.

  • viewerMode=2D|3D - Selects the viewer type, either 2D or 3D

  • component - Specifies the data component to display (only for 3D devices), for example Intensity or Height.

Additionally if viewerMode is set to 3D, the following options are available:

  • floor=true|false - Show or hide the floor.

  • lighting=true|false - Enable or disable lighting.

  • specularHighlights=true|false - Enable or disable specular highlights.

  • background=blue|light|dark - Set the background color. Possible values: dark (black), light (white), blue (default blue gradient).

  • colorMap=turbo|jet|black-white|red-green - Select the color map for sensor data visualization. Possible values: turbo, jet, black-white, red-green.

Example:

http://<ip>/#/viewer?hideShell=true&viewerMode=3D&component=Height&floor=true&lighting=true&specularHighlights=false&background=blue&colorMap=jet